Interface Simulation

All Superinterfaces:
IPCObject
All Known Implementing Classes:
SimulationImpl

public interface Simulation extends IPCObject
Information provided by the PKI file:

    \class Simulation
    
    \brief Simulation holds the traffic details like PDUs, ports, etc.
    
    \example simulation()
    
Author:
Auto-generated
  • Method Details

    • getFrameInstanceCount

      int getFrameInstanceCount()
      Information provided by the PKI file:
      
          \brief Returns the number of FrameInstances at present in the simulation.
          
          \return int, the number of FrameInstances at present in the simulation.
          
              
      Returns:
      int Returns a int
    • getFrameInstanceAt

      FrameInstance getFrameInstanceAt(int nodeIndex)
      Information provided by the PKI file:
      
          \brief Returns the FrameInstance at the specified index in the simulation event list.
          
          \param nodeIndex, the index of FrameInstance of interest.
          
          \return FrameInstance, the FrameInstance object at the specified index in the simulation event list.
          
              
      Parameters:
      nodeIndex - Takes in a parameter of nodeIndex
      Returns:
      FrameInstance Returns a FrameInstance
    • getCurrentFrameInstanceIndex

      int getCurrentFrameInstanceIndex()
      Information provided by the PKI file:
      
          \brief Returns index of "current" frame instance.
          
              
      Returns:
      int Returns a int
    • resetSimulation

      void resetSimulation()
      Information provided by the PKI file:
      
          \brief Resets simulation and fires the event.
          
              
    • isSimulationMode

      boolean isSimulationMode()
      Information provided by the PKI file:
      
          \brief Returns true if in Simulation Mode, otherwise false.
          
          \return bool, true if in Simulation Mode, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • createTimer

      SimulationTimer createTimer(int delay, boolean bAddRandom)
      Information provided by the PKI file:
      
          \brief Create Simulation Timer
          
          \param delay, delay time before timer expires
          
          \param bAddRandom, true to set the timer to expire at random time and false to not including the random factor
          
          \return SimulationTimer, SimulationTimer object
          
              
      Parameters:
      delay - Takes in a parameter of delay
      bAddRandom - Takes in a parameter of bAddRandom
      Returns:
      SimulationTimer Returns a SimulationTimer
    • createTimerUuid

      UUID createTimerUuid(int delay, boolean bAddRandom)
      Information provided by the PKI file:
      
          \brief Create Simulation Timer and return the uuid of the timer object
          
          \param delay, delay time before timer expires
          
          \param bAddRandom, true to set the timer to expire at random time and false to not including the random factor
          
          \return uuid, SimulationTimer object's uuid
          
              
      Parameters:
      delay - Takes in a parameter of delay
      bAddRandom - Takes in a parameter of bAddRandom
      Returns:
      UUID Returns a UUID
    • getIpcTimer

      SimulationTimer getIpcTimer(UUID uuid)
      Information provided by the PKI file:
      
          \brief Get Simulation Timer based on uuid
          
          \param uuid, uuid of the timer
          
          \return SimulationTimer, SimulationTimer object
          
              
      Parameters:
      uuid - Takes in a parameter of uuid
      Returns:
      SimulationTimer Returns a SimulationTimer
    • getCurrentSimTime

      long getCurrentSimTime()
      Information provided by the PKI file:
      
          \brief Get Current Simulation Time
          
          \return long, Current Simulation Time
          
              
      Returns:
      long Returns a long
    • setSimulationMode

      void setSimulationMode(boolean toSimMode)
      Information provided by the PKI file:
      
          \brief Sets the mode to simulation mode
          \arg toSimMode, whether to change to simulation mode or not (realtime).
          
              
      Parameters:
      toSimMode - Takes in a parameter of toSimMode
    • forward

      void forward()
      Information provided by the PKI file:
      
          \brief Forwards the simulation by 1 step
          
              
    • backward

      void backward()
      Information provided by the PKI file:
      
          \brief Backs the simulation by 1 step